Improve handling of quota limit reached errors #610
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
agateau-gg
requested changes
Jul 5, 2023
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## main #610 +/- ##
==========================================
+ Coverage 93.84% 93.85% +0.01%
==========================================
Files 104 104
Lines 4844 4853 +9
==========================================
+ Hits 4546 4555 +9
Misses 298 298
Flags with carried forward coverage won't be shown. Click here to find out more.
|
When quota limit is reached ggshield: - prints this error: "Could not perform the requested action: no more API calls available." - exits with an error code of 128 - does not print anything through the output handlers (no text report, no JSON report)
Walz
force-pushed
the
samuel/scrt-3734-ggshield-improve-handling-of-quota-limit-reached-errors
branch
from
4f0ccbc
to
10fef6f
Compare
agateau-gg
deleted the
samuel/scrt-3734-ggshield-improve-handling-of-quota-limit-reached-errors
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #309
Problem
The output of ggshield when the quota limit is reached can be confusing:
Even more with the JSON output:
$ ggshield secret scan path setup.py --json Scanning Path... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 0% 0 files scanned out of 1 -:--:-- Scanning failed. Results may be incomplete. The following chunk is affected: /Users/sguillaume/gg-src/ggshield/setup.py 403:Quota limit reached. Scanning Path... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 1 files scanned out of 1 0:00:00 {"id": "/Users/sguillaume/gg-src/ggshield/setup.py", "type": "path_scan", "total_incidents": 0, "total_occurrences": 0}The error code is 0, and ggshield say that no secret have been found, when no file have been scanned.
Solution
I've added an exception
QuotaLimitReachedErrorwhich is raised bySecretScanner._collect_resultswhen ggshield receives a 403 with the messageQuota limit reached.. This exception is then passed all the way to up andscan_commit_rangehas been updated to stop as soon as an exception occurs.The new output is:
The output handler is not called and the exit code is 128.
It also stop a large scan if the error happens in the middle of the scan:
The PR also include a small commit to fix the a version specifier in the Pipfile. My version of pipenv didn't like the missing
==.